STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: hspc-crd

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-crd

The HSPC specific profile for recording the total radiation dose an individual has received throughout life

This profile was published on Tue, Oct 20, 2015 00:00+1100 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from QICore-Observation.

Summary

Mandatory: 1 element
Must-Support: 1 element
Fixed Value: 3 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

This structure is derived from QICore-Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... observation-bodyPosition 0..0
... status 1..1codeBinding: ObservationStatusBasic (required)
... issued 0..0
... performer 0..*Reference(HSPC ProviderPractitioner)
... valueQuantity 1..1Quantity
.... unit 0..1stringFixed Value: milli Sievert
.... system 0..1uriFixed Value: http://unitsofmeasure.org
.... code 0..1codeFixed Value: mSv
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... observation-bodyPosition 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
Binding: Body Position (preferred)
... hspc-extensionsfocalSubject ?! S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsfocalSubject
Binding: HSPC FocalSubject (preferred)
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatusBasic (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptType of observation (code / type)
Binding: US Laboratory Observation Profile Observation Name Codes (preferred)
... subject S ∑0..1Reference(QICore-Patient | Group | QICore-Device | QICore-Location)Who and/or what this is about
... encounter S0..1Reference(QICore-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner)Who is responsible for the observation
... valueQuantity S ∑1..1QuantityActual result
Binding: SNOMED CT Codes (preferred)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑0..1stringUnit representation
Fixed Value: milli Sievert
.... system ∑ I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑0..1codeCoded form of the unit
Fixed Value: mSv
... comment 0..1stringComments about result
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from QICore-Observation.

Summary

Mandatory: 1 element
Must-Support: 1 element
Fixed Value: 3 elements
Prohibited: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from QICore-Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*Observation
... observation-bodyPosition 0..0
... status 1..1codeBinding: ObservationStatusBasic (required)
... issued 0..0
... performer 0..*Reference(HSPC ProviderPractitioner)
... valueQuantity 1..1Quantity
.... unit 0..1stringFixed Value: milli Sievert
.... system 0..1uriFixed Value: http://unitsofmeasure.org
.... code 0..1codeFixed Value: mSv
... dataAbsentReason 0..0
... interpretation 0..0
... bodySite 0..0
... method 0..0
... specimen 0..0
... device 0..0
... referenceRange 0..0
... related 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... observation-bodyPosition 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/observation-bodyPosition
Binding: Body Position (preferred)
... hspc-extensionsfocalSubject ?! S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsfocalSubject
Binding: HSPC FocalSubject (preferred)
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatusBasic (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptType of observation (code / type)
Binding: US Laboratory Observation Profile Observation Name Codes (preferred)
... subject S ∑0..1Reference(QICore-Patient | Group | QICore-Device | QICore-Location)Who and/or what this is about
... encounter S0..1Reference(QICore-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner)Who is responsible for the observation
... valueQuantity S ∑1..1QuantityActual result
Binding: SNOMED CT Codes (preferred)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑0..1stringUnit representation
Fixed Value: milli Sievert
.... system ∑ I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑0..1codeCoded form of the unit
Fixed Value: mSv
... comment 0..1stringComments about result
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.extension
[UriType[http://hl7.org/fhir/StructureDefinition/observation-bodyPosition]]		Body PositionpreferredBody Position
Observation.modifierExtension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsfocalSubject]]		HSPC FocalSubjectpreferredHSPC FocalSubject
Observation.statusObservationStatusBasicrequiredObservationStatusBasic
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeUS Laboratory Observation Profile Observation Name CodespreferredUS Laboratory Observation Profile Observation Name Codes
Observation.valueQuantitySNOMED CT CodespreferredSNOMED CT Codes
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

H.??.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
.